<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>TorqueJDBCTransformTask xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/task/TorqueJDBCTransformTask.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/task/package-summary.html">org.apache.torque.task</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.io.FileOutputStream;
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.PrintWriter;
<a name="24" href="#24">24</a>  <strong>import</strong> java.sql.Connection;
<a name="25" href="#25">25</a>  <strong>import</strong> java.sql.DatabaseMetaData;
<a name="26" href="#26">26</a>  <strong>import</strong> java.sql.DriverManager;
<a name="27" href="#27">27</a>  <strong>import</strong> java.sql.ResultSet;
<a name="28" href="#28">28</a>  <strong>import</strong> java.sql.SQLException;
<a name="29" href="#29">29</a>  <strong>import</strong> java.sql.Types;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.ArrayList;
<a name="31" href="#31">31</a>  <strong>import</strong> java.util.Collection;
<a name="32" href="#32">32</a>  <strong>import</strong> java.util.Hashtable;
<a name="33" href="#33">33</a>  <strong>import</strong> java.util.Iterator;
<a name="34" href="#34">34</a>  <strong>import</strong> java.util.List;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="37" href="#37">37</a>  <strong>import</strong> org.apache.tools.ant.BuildException;
<a name="38" href="#38">38</a>  <strong>import</strong> org.apache.tools.ant.Project;
<a name="39" href="#39">39</a>  <strong>import</strong> org.apache.tools.ant.Task;
<a name="40" href="#40">40</a>  <strong>import</strong> org.apache.torque.engine.database.model.TypeMap;
<a name="41" href="#41">41</a>  <strong>import</strong> org.apache.torque.engine.database.transform.DTDResolver;
<a name="42" href="#42">42</a>  <strong>import</strong> org.apache.xerces.dom.DocumentImpl;
<a name="43" href="#43">43</a>  <strong>import</strong> org.apache.xerces.dom.DocumentTypeImpl;
<a name="44" href="#44">44</a>  <strong>import</strong> org.apache.xml.serialize.Method;
<a name="45" href="#45">45</a>  <strong>import</strong> org.apache.xml.serialize.OutputFormat;
<a name="46" href="#46">46</a>  <strong>import</strong> org.apache.xml.serialize.XMLSerializer;
<a name="47" href="#47">47</a>  <strong>import</strong> org.w3c.dom.Element;
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>  <em>/**<em>*</em></em>
<a name="50" href="#50">50</a>  <em> * This class generates an XML schema of an existing database from</em>
<a name="51" href="#51">51</a>  <em> * JDBC metadata.</em>
<a name="52" href="#52">52</a>  <em> *</em>
<a name="53" href="#53">53</a>  <em> * @author &lt;a href="<a href="mailto:jvanzyl@periapt.com" target="alexandria_uri">mailto:jvanzyl@periapt.com</a>">Jason van Zyl&lt;/a></em>
<a name="54" href="#54">54</a>  <em> * @author &lt;a href="<a href="mailto:fedor.karpelevitch@barra.com" target="alexandria_uri">mailto:fedor.karpelevitch@barra.com</a>">Fedor Karpelevitch&lt;/a></em>
<a name="55" href="#55">55</a>  <em> * @version $Id: TorqueJDBCTransformTask.java 502761 2007-02-02 21:52:05Z tfischer $</em>
<a name="56" href="#56">56</a>  <em> */</em>
<a name="57" href="#57">57</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/torque/task/TorqueJDBCTransformTask.html">TorqueJDBCTransformTask</a> <strong>extends</strong> Task
<a name="58" href="#58">58</a>  {
<a name="59" href="#59">59</a>      <em>/**<em>* Name of XML database schema produced. */</em></em>
<a name="60" href="#60">60</a>      <strong>protected</strong> String xmlSchema;
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>      <em>/**<em>* JDBC URL. */</em></em>
<a name="63" href="#63">63</a>      <strong>protected</strong> String dbUrl;
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>      <em>/**<em>* JDBC driver. */</em></em>
<a name="66" href="#66">66</a>      <strong>protected</strong> String dbDriver;
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>      <em>/**<em>* JDBC user name. */</em></em>
<a name="69" href="#69">69</a>      <strong>protected</strong> String dbUser;
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>      <em>/**<em>* JDBC password. */</em></em>
<a name="72" href="#72">72</a>      <strong>protected</strong> String dbPassword;
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em>/**<em>* DB schema to use. */</em></em>
<a name="75" href="#75">75</a>      <strong>protected</strong> String dbSchema;
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>      <em>/**<em>* DOM document produced. */</em></em>
<a name="78" href="#78">78</a>      <strong>protected</strong> DocumentImpl doc;
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em>/**<em>* The document root element. */</em></em>
<a name="81" href="#81">81</a>      <strong>protected</strong> Element databaseNode;
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em>/**<em>* Hashtable of columns that have primary keys. */</em></em>
<a name="84" href="#84">84</a>      <strong>protected</strong> Hashtable primaryKeys;
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <em>/**<em>* Hashtable to track what table a column belongs to. */</em></em>
<a name="87" href="#87">87</a>      <strong>protected</strong> Hashtable columnTableMap;
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <strong>protected</strong> <strong>boolean</strong> sameJavaName;
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>      <strong>private</strong> XMLSerializer xmlSerializer;
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      <strong>public</strong> String getDbSchema()
<a name="94" href="#94">94</a>      {
<a name="95" href="#95">95</a>          <strong>return</strong> dbSchema;
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <strong>public</strong> <strong>void</strong> setDbSchema(String dbSchema)
<a name="99" href="#99">99</a>      {
<a name="100" href="#100">100</a>         <strong>this</strong>.dbSchema = dbSchema;
<a name="101" href="#101">101</a>     }
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>     <strong>public</strong> <strong>void</strong> setDbUrl(String v)
<a name="104" href="#104">104</a>     {
<a name="105" href="#105">105</a>         dbUrl = v;
<a name="106" href="#106">106</a>     }
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <strong>public</strong> <strong>void</strong> setDbDriver(String v)
<a name="109" href="#109">109</a>     {
<a name="110" href="#110">110</a>         dbDriver = v;
<a name="111" href="#111">111</a>     }
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>     <strong>public</strong> <strong>void</strong> setDbUser(String v)
<a name="114" href="#114">114</a>     {
<a name="115" href="#115">115</a>         dbUser = v;
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <strong>public</strong> <strong>void</strong> setDbPassword(String v)
<a name="119" href="#119">119</a>     {
<a name="120" href="#120">120</a>         dbPassword = v;
<a name="121" href="#121">121</a>     }
<a name="122" href="#122">122</a> 
<a name="123" href="#123">123</a>     <strong>public</strong> <strong>void</strong> setOutputFile (String v)
<a name="124" href="#124">124</a>     {
<a name="125" href="#125">125</a>         xmlSchema = v;
<a name="126" href="#126">126</a>     }
<a name="127" href="#127">127</a> 
<a name="128" href="#128">128</a>     <strong>public</strong> <strong>void</strong> setSameJavaName(<strong>boolean</strong> v)
<a name="129" href="#129">129</a>     {
<a name="130" href="#130">130</a>         <strong>this</strong>.sameJavaName = v;
<a name="131" href="#131">131</a>     }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <strong>public</strong> <strong>boolean</strong> isSameJavaName()
<a name="134" href="#134">134</a>     {
<a name="135" href="#135">135</a>         <strong>return</strong> <strong>this</strong>.sameJavaName;
<a name="136" href="#136">136</a>     }
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     <em>/**<em>*</em></em>
<a name="139" href="#139">139</a> <em>     * Default constructor.</em>
<a name="140" href="#140">140</a> <em>     *</em>
<a name="141" href="#141">141</a> <em>     * @throws BuildException</em>
<a name="142" href="#142">142</a> <em>     */</em>
<a name="143" href="#143">143</a>     <strong>public</strong> <strong>void</strong> execute() throws BuildException
<a name="144" href="#144">144</a>     {
<a name="145" href="#145">145</a>         log(<span class="string">"Torque - JDBCToXMLSchema starting"</span>);
<a name="146" href="#146">146</a>         log(<span class="string">"Your DB settings are:"</span>);
<a name="147" href="#147">147</a>         log(<span class="string">"driver : "</span> + dbDriver);
<a name="148" href="#148">148</a>         log(<span class="string">"URL : "</span> + dbUrl);
<a name="149" href="#149">149</a>         log(<span class="string">"user : "</span> + dbUser);
<a name="150" href="#150">150</a>         <em class="comment">// log("password : " + dbPassword);</em>
<a name="151" href="#151">151</a>         log(<span class="string">"schema : "</span> + dbSchema);
<a name="152" href="#152">152</a> 
<a name="153" href="#153">153</a>         DocumentTypeImpl docType = <strong>new</strong> DocumentTypeImpl(<strong>null</strong>, <span class="string">"database"</span>, <strong>null</strong>,
<a name="154" href="#154">154</a>                 DTDResolver.WEB_SITE_DTD);
<a name="155" href="#155">155</a>         doc = <strong>new</strong> DocumentImpl(docType);
<a name="156" href="#156">156</a>         doc.appendChild(doc.createComment(
<a name="157" href="#157">157</a>                 <span class="string">" Autogenerated by JDBCToXMLSchema! "</span>));
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>         <strong>try</strong>
<a name="160" href="#160">160</a>         {
<a name="161" href="#161">161</a>             generateXML();
<a name="162" href="#162">162</a>             log(xmlSchema);
<a name="163" href="#163">163</a>             xmlSerializer = <strong>new</strong> XMLSerializer(
<a name="164" href="#164">164</a>                     <strong>new</strong> PrintWriter(
<a name="165" href="#165">165</a>                     <strong>new</strong> FileOutputStream(xmlSchema)),
<a name="166" href="#166">166</a>                     <strong>new</strong> OutputFormat(Method.XML, <strong>null</strong>, <strong>true</strong>));
<a name="167" href="#167">167</a>             xmlSerializer.serialize(doc);
<a name="168" href="#168">168</a>         }
<a name="169" href="#169">169</a>         <strong>catch</strong> (Exception e)
<a name="170" href="#170">170</a>         {
<a name="171" href="#171">171</a>             <strong>throw</strong> <strong>new</strong> BuildException(e);
<a name="172" href="#172">172</a>         }
<a name="173" href="#173">173</a>         log(<span class="string">"Torque - JDBCToXMLSchema finished"</span>);
<a name="174" href="#174">174</a>     }
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>     <em>/**<em>*</em></em>
<a name="177" href="#177">177</a> <em>     * Generates an XML database schema from JDBC metadata.</em>
<a name="178" href="#178">178</a> <em>     *</em>
<a name="179" href="#179">179</a> <em>     * @throws Exception a generic exception.</em>
<a name="180" href="#180">180</a> <em>     */</em>
<a name="181" href="#181">181</a>     <strong>public</strong> <strong>void</strong> generateXML() throws Exception
<a name="182" href="#182">182</a>     {
<a name="183" href="#183">183</a>         <em class="comment">// Load the Interbase Driver.</em>
<a name="184" href="#184">184</a>         Class.forName(dbDriver);
<a name="185" href="#185">185</a>         log(<span class="string">"DB driver sucessfuly instantiated"</span>);
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a>         Connection con = <strong>null</strong>;
<a name="188" href="#188">188</a>         <strong>try</strong>
<a name="189" href="#189">189</a>         {
<a name="190" href="#190">190</a>             <em class="comment">// Attempt to connect to a database.</em>
<a name="191" href="#191">191</a>             con = DriverManager.getConnection(dbUrl, dbUser, dbPassword);
<a name="192" href="#192">192</a>             log(<span class="string">"DB connection established"</span>);
<a name="193" href="#193">193</a> 
<a name="194" href="#194">194</a>             <em class="comment">// Get the database Metadata.</em>
<a name="195" href="#195">195</a>             DatabaseMetaData dbMetaData = con.getMetaData();
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>             <em class="comment">// The database map.</em>
<a name="198" href="#198">198</a>             List tableList = getTableNames(dbMetaData);
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>             databaseNode = doc.createElement(<span class="string">"database"</span>);
<a name="201" href="#201">201</a>             databaseNode.setAttribute(<span class="string">"name"</span>, dbUser);
<a name="202" href="#202">202</a> 
<a name="203" href="#203">203</a>             <em class="comment">// Build a database-wide column -> table map.</em>
<a name="204" href="#204">204</a>             columnTableMap = <strong>new</strong> Hashtable();
<a name="205" href="#205">205</a> 
<a name="206" href="#206">206</a>             log(<span class="string">"Building column/table map..."</span>);
<a name="207" href="#207">207</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; tableList.size(); i++)
<a name="208" href="#208">208</a>             {
<a name="209" href="#209">209</a>                 String curTable = (String) tableList.get(i);
<a name="210" href="#210">210</a>                 List columns = getColumns(dbMetaData, curTable);
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>                 <strong>for</strong> (<strong>int</strong> j = 0; j &lt; columns.size(); j++)
<a name="213" href="#213">213</a>                 {
<a name="214" href="#214">214</a>                     List col = (List) columns.get(j);
<a name="215" href="#215">215</a>                     String name = (String) col.get(0);
<a name="216" href="#216">216</a> 
<a name="217" href="#217">217</a>                     columnTableMap.put(name, curTable);
<a name="218" href="#218">218</a>                 }
<a name="219" href="#219">219</a>             }
<a name="220" href="#220">220</a> 
<a name="221" href="#221">221</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; tableList.size(); i++)
<a name="222" href="#222">222</a>             {
<a name="223" href="#223">223</a>                 <em class="comment">// Add Table.</em>
<a name="224" href="#224">224</a>                 String curTable = (String) tableList.get(i);
<a name="225" href="#225">225</a>                 <em class="comment">// dbMap.addTable(curTable);</em>
<a name="226" href="#226">226</a>                 log(<span class="string">"Processing table: "</span> + curTable);
<a name="227" href="#227">227</a> 
<a name="228" href="#228">228</a>                 Element table = doc.createElement(<span class="string">"table"</span>);
<a name="229" href="#229">229</a>                 table.setAttribute(<span class="string">"name"</span>, curTable);
<a name="230" href="#230">230</a>                 <strong>if</strong> (isSameJavaName())
<a name="231" href="#231">231</a>                 {
<a name="232" href="#232">232</a>                     table.setAttribute(<span class="string">"javaName"</span>, curTable);
<a name="233" href="#233">233</a>                 }
<a name="234" href="#234">234</a> 
<a name="235" href="#235">235</a>                 <em class="comment">// Add Columns.</em>
<a name="236" href="#236">236</a>                 <em class="comment">// TableMap tblMap = dbMap.getTable(curTable);</em>
<a name="237" href="#237">237</a> 
<a name="238" href="#238">238</a>                 List columns = getColumns(dbMetaData, curTable);
<a name="239" href="#239">239</a>                 List primKeys = getPrimaryKeys(dbMetaData, curTable);
<a name="240" href="#240">240</a>                 Collection forgnKeys = getForeignKeys(dbMetaData, curTable);
<a name="241" href="#241">241</a> 
<a name="242" href="#242">242</a>                 <em class="comment">// Set the primary keys.</em>
<a name="243" href="#243">243</a>                 primaryKeys = <strong>new</strong> Hashtable();
<a name="244" href="#244">244</a> 
<a name="245" href="#245">245</a>                 <strong>for</strong> (<strong>int</strong> k = 0; k &lt; primKeys.size(); k++)
<a name="246" href="#246">246</a>                 {
<a name="247" href="#247">247</a>                     String curPrimaryKey = (String) primKeys.get(k);
<a name="248" href="#248">248</a>                     primaryKeys.put(curPrimaryKey, curPrimaryKey);
<a name="249" href="#249">249</a>                 }
<a name="250" href="#250">250</a> 
<a name="251" href="#251">251</a>                 <strong>for</strong> (<strong>int</strong> j = 0; j &lt; columns.size(); j++)
<a name="252" href="#252">252</a>                 {
<a name="253" href="#253">253</a>                     List col = (List) columns.get(j);
<a name="254" href="#254">254</a>                     String name = (String) col.get(0);
<a name="255" href="#255">255</a>                     Integer type = ((Integer) col.get(1));
<a name="256" href="#256">256</a>                     <strong>int</strong> size = ((Integer) col.get(2)).<strong>int</strong>Value();
<a name="257" href="#257">257</a>                     <strong>int</strong> scale = ((Integer) col.get(5)).<strong>int</strong>Value();
<a name="258" href="#258">258</a> 
<a name="259" href="#259">259</a>                     <em class="comment">// From DatabaseMetaData.java</em>
<a name="260" href="#260">260</a>                     <em class="comment">//</em>
<a name="261" href="#261">261</a>                     <em class="comment">// Indicates column might not allow NULL values.  Huh?</em>
<a name="262" href="#262">262</a>                     <em class="comment">// Might? Boy, that's a definitive answer.</em>
<a name="263" href="#263">263</a>                     <em class="comment">/*<em class="comment"> int columnNoNulls = 0; */</em></em>
<a name="264" href="#264">264</a> 
<a name="265" href="#265">265</a>                     <em class="comment">// Indicates column definitely allows NULL values.</em>
<a name="266" href="#266">266</a>                     <em class="comment">/*<em class="comment"> int columnNullable = 1; */</em></em>
<a name="267" href="#267">267</a> 
<a name="268" href="#268">268</a>                     <em class="comment">// Indicates NULLABILITY of column is unknown.</em>
<a name="269" href="#269">269</a>                     <em class="comment">/*<em class="comment"> int columnNullableUnknown = 2; */</em></em>
<a name="270" href="#270">270</a> 
<a name="271" href="#271">271</a>                     Integer nullType = (Integer) col.get(3);
<a name="272" href="#272">272</a>                     String defValue = (String) col.get(4);
<a name="273" href="#273">273</a> 
<a name="274" href="#274">274</a>                     Element column = doc.createElement(<span class="string">"column"</span>);
<a name="275" href="#275">275</a>                     column.setAttribute(<span class="string">"name"</span>, name);
<a name="276" href="#276">276</a>                     <strong>if</strong> (isSameJavaName())
<a name="277" href="#277">277</a>                     {
<a name="278" href="#278">278</a>                         column.setAttribute(<span class="string">"javaName"</span>, name);
<a name="279" href="#279">279</a>                     }
<a name="280" href="#280">280</a> 
<a name="281" href="#281">281</a>                     column.setAttribute(<span class="string">"type"</span>, TypeMap.getTorqueType(type).getName());
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>                     <strong>if</strong> (size > 0 &amp;&amp; (type.intValue() == Types.CHAR
<a name="284" href="#284">284</a>                             || type.intValue() == Types.VARCHAR
<a name="285" href="#285">285</a>                             || type.intValue() == Types.LONGVARCHAR
<a name="286" href="#286">286</a>                             || type.intValue() == Types.DECIMAL
<a name="287" href="#287">287</a>                             || type.intValue() == Types.NUMERIC))
<a name="288" href="#288">288</a>                     {
<a name="289" href="#289">289</a>                         column.setAttribute(<span class="string">"size"</span>, String.valueOf(size));
<a name="290" href="#290">290</a>                     }
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>                     <strong>if</strong> (scale > 0 &amp;&amp; (type.intValue() == Types.DECIMAL
<a name="293" href="#293">293</a>                             || type.intValue() == Types.NUMERIC))
<a name="294" href="#294">294</a>                     {
<a name="295" href="#295">295</a>                         column.setAttribute(<span class="string">"scale"</span>, String.valueOf(scale));
<a name="296" href="#296">296</a>                     }
<a name="297" href="#297">297</a> 
<a name="298" href="#298">298</a>                     <strong>if</strong> (nullType.intValue() == 0)
<a name="299" href="#299">299</a>                     {
<a name="300" href="#300">300</a>                         column.setAttribute(<span class="string">"required"</span>, <span class="string">"true"</span>);
<a name="301" href="#301">301</a>                     }
<a name="302" href="#302">302</a> 
<a name="303" href="#303">303</a>                     <strong>if</strong> (primaryKeys.containsKey(name))
<a name="304" href="#304">304</a>                     {
<a name="305" href="#305">305</a>                         column.setAttribute(<span class="string">"primaryKey"</span>, <span class="string">"true"</span>);
<a name="306" href="#306">306</a>                     }
<a name="307" href="#307">307</a> 
<a name="308" href="#308">308</a>                     <strong>if</strong> (StringUtils.isNotEmpty(defValue))
<a name="309" href="#309">309</a>                     {
<a name="310" href="#310">310</a>                         <em class="comment">// trim out parens &amp; quotes out of def value.</em>
<a name="311" href="#311">311</a>                         <em class="comment">// makes sense for MSSQL. not sure about others.</em>
<a name="312" href="#312">312</a>                         <strong>if</strong> (defValue.startsWith(<span class="string">"("</span>) &amp;&amp; defValue.endsWith(<span class="string">")"</span>))
<a name="313" href="#313">313</a>                         {
<a name="314" href="#314">314</a>                             defValue = defValue.substring(1, defValue.length() - 1);
<a name="315" href="#315">315</a>                         }
<a name="316" href="#316">316</a> 
<a name="317" href="#317">317</a>                         <strong>if</strong> (defValue.startsWith(<span class="string">"'"</span>) &amp;&amp; defValue.endsWith(<span class="string">"'"</span>))
<a name="318" href="#318">318</a>                         {
<a name="319" href="#319">319</a>                             defValue = defValue.substring(1, defValue.length() - 1);
<a name="320" href="#320">320</a>                         }
<a name="321" href="#321">321</a> 
<a name="322" href="#322">322</a>                         column.setAttribute(<span class="string">"default"</span>, defValue);
<a name="323" href="#323">323</a>                     }
<a name="324" href="#324">324</a>                     table.appendChild(column);
<a name="325" href="#325">325</a>                 }
<a name="326" href="#326">326</a> 
<a name="327" href="#327">327</a>                 <em class="comment">// Foreign keys for this table.</em>
<a name="328" href="#328">328</a>                 <strong>for</strong> (Iterator l = <strong>for</strong>gnKeys.iterator(); l.hasNext();)
<a name="329" href="#329">329</a>                 {
<a name="330" href="#330">330</a>                     Object[] forKey = (Object[]) l.next();
<a name="331" href="#331">331</a>                     String foreignKeyTable = (String) forKey[0];
<a name="332" href="#332">332</a>                     List refs = (List) forKey[1];
<a name="333" href="#333">333</a>                     Element fk = doc.createElement(<span class="string">"foreign-key"</span>);
<a name="334" href="#334">334</a>                     fk.setAttribute(<span class="string">"foreignTable"</span>, foreignKeyTable);
<a name="335" href="#335">335</a>                     <strong>for</strong> (<strong>int</strong> m = 0; m &lt; refs.size(); m++)
<a name="336" href="#336">336</a>                     {
<a name="337" href="#337">337</a>                         Element ref = doc.createElement(<span class="string">"reference"</span>);
<a name="338" href="#338">338</a>                         String[] refData = (String[]) refs.get(m);
<a name="339" href="#339">339</a>                         ref.setAttribute(<span class="string">"local"</span>, refData[0]);
<a name="340" href="#340">340</a>                         ref.setAttribute(<span class="string">"foreign"</span>, refData[1]);
<a name="341" href="#341">341</a>                         fk.appendChild(ref);
<a name="342" href="#342">342</a>                     }
<a name="343" href="#343">343</a>                     table.appendChild(fk);
<a name="344" href="#344">344</a>                 }
<a name="345" href="#345">345</a>                 databaseNode.appendChild(table);
<a name="346" href="#346">346</a>             }
<a name="347" href="#347">347</a>             doc.appendChild(databaseNode);
<a name="348" href="#348">348</a>         }
<a name="349" href="#349">349</a>         <strong>finally</strong>
<a name="350" href="#350">350</a>         {
<a name="351" href="#351">351</a>             <strong>if</strong> (con != <strong>null</strong>)
<a name="352" href="#352">352</a>             {
<a name="353" href="#353">353</a>                 con.close();
<a name="354" href="#354">354</a>                 con = <strong>null</strong>;
<a name="355" href="#355">355</a>             }
<a name="356" href="#356">356</a>         }
<a name="357" href="#357">357</a>     }
<a name="358" href="#358">358</a> 
<a name="359" href="#359">359</a>     <em>/**<em>*</em></em>
<a name="360" href="#360">360</a> <em>     * Get all the table names in the current database that are not</em>
<a name="361" href="#361">361</a> <em>     * system tables.</em>
<a name="362" href="#362">362</a> <em>     *</em>
<a name="363" href="#363">363</a> <em>     * @param dbMeta JDBC database metadata.</em>
<a name="364" href="#364">364</a> <em>     * @return The list of all the tables in a database.</em>
<a name="365" href="#365">365</a> <em>     * @throws SQLException</em>
<a name="366" href="#366">366</a> <em>     */</em>
<a name="367" href="#367">367</a>     <strong>public</strong> List getTableNames(DatabaseMetaData dbMeta)
<a name="368" href="#368">368</a>         throws SQLException
<a name="369" href="#369">369</a>     {
<a name="370" href="#370">370</a>         log(<span class="string">"Getting table list..."</span>);
<a name="371" href="#371">371</a>         List tables = <strong>new</strong> ArrayList();
<a name="372" href="#372">372</a>         ResultSet tableNames = <strong>null</strong>;
<a name="373" href="#373">373</a>         <em class="comment">// these are the entity types we want from the database</em>
<a name="374" href="#374">374</a>         String[] types = {<span class="string">"TABLE"</span>, <span class="string">"VIEW"</span>};
<a name="375" href="#375">375</a>         <strong>try</strong>
<a name="376" href="#376">376</a>         {
<a name="377" href="#377">377</a>             tableNames = dbMeta.getTables(<strong>null</strong>, dbSchema, <span class="string">"%"</span>, types);
<a name="378" href="#378">378</a>             <strong>while</strong> (tableNames.next())
<a name="379" href="#379">379</a>             {
<a name="380" href="#380">380</a>                 String name = tableNames.getString(3);
<a name="381" href="#381">381</a>                 tables.add(name);
<a name="382" href="#382">382</a>             }
<a name="383" href="#383">383</a>         }
<a name="384" href="#384">384</a>         <strong>finally</strong>
<a name="385" href="#385">385</a>         {
<a name="386" href="#386">386</a>             <strong>if</strong> (tableNames != <strong>null</strong>)
<a name="387" href="#387">387</a>             {
<a name="388" href="#388">388</a>                 tableNames.close();
<a name="389" href="#389">389</a>             }
<a name="390" href="#390">390</a>         }
<a name="391" href="#391">391</a>         <strong>return</strong> tables;
<a name="392" href="#392">392</a>     }
<a name="393" href="#393">393</a> 
<a name="394" href="#394">394</a>     <em>/**<em>*</em></em>
<a name="395" href="#395">395</a> <em>     * Retrieves all the column names and types for a given table from</em>
<a name="396" href="#396">396</a> <em>     * JDBC metadata.  It returns a List of Lists.  Each element</em>
<a name="397" href="#397">397</a> <em>     * of the returned List is a List with:</em>
<a name="398" href="#398">398</a> <em>     *</em>
<a name="399" href="#399">399</a> <em>     * element 0 => a String object for the column name.</em>
<a name="400" href="#400">400</a> <em>     * element 1 => an Integer object for the column type.</em>
<a name="401" href="#401">401</a> <em>     * element 2 => size of the column.</em>
<a name="402" href="#402">402</a> <em>     * element 3 => null type.</em>
<a name="403" href="#403">403</a> <em>     *</em>
<a name="404" href="#404">404</a> <em>     * @param dbMeta JDBC metadata.</em>
<a name="405" href="#405">405</a> <em>     * @param tableName Table from which to retrieve column information.</em>
<a name="406" href="#406">406</a> <em>     * @return The list of columns in &lt;code>tableName&lt;/code>.</em>
<a name="407" href="#407">407</a> <em>     * @throws SQLException</em>
<a name="408" href="#408">408</a> <em>     */</em>
<a name="409" href="#409">409</a>     <strong>public</strong> List getColumns(DatabaseMetaData dbMeta, String tableName)
<a name="410" href="#410">410</a>             throws SQLException
<a name="411" href="#411">411</a>     {
<a name="412" href="#412">412</a>         List columns = <strong>new</strong> ArrayList();
<a name="413" href="#413">413</a>         ResultSet columnSet = <strong>null</strong>;
<a name="414" href="#414">414</a>         <strong>try</strong>
<a name="415" href="#415">415</a>         {
<a name="416" href="#416">416</a>             columnSet = dbMeta.getColumns(<strong>null</strong>, dbSchema, tableName, <strong>null</strong>);
<a name="417" href="#417">417</a>             <strong>while</strong> (columnSet.next())
<a name="418" href="#418">418</a>             {
<a name="419" href="#419">419</a>                 String name = columnSet.getString(4);
<a name="420" href="#420">420</a>                 Integer sqlType = <strong>new</strong> Integer(columnSet.getString(5));
<a name="421" href="#421">421</a>                 Integer size = <strong>new</strong> Integer(columnSet.getInt(7));
<a name="422" href="#422">422</a>                 Integer decimalDigits = <strong>new</strong> Integer(columnSet.getInt(9));
<a name="423" href="#423">423</a>                 Integer nullType = <strong>new</strong> Integer(columnSet.getInt(11));
<a name="424" href="#424">424</a>                 String defValue = columnSet.getString(13);
<a name="425" href="#425">425</a> 
<a name="426" href="#426">426</a>                 List col = <strong>new</strong> ArrayList(6);
<a name="427" href="#427">427</a>                 col.add(name);
<a name="428" href="#428">428</a>                 col.add(sqlType);
<a name="429" href="#429">429</a>                 col.add(size);
<a name="430" href="#430">430</a>                 col.add(nullType);
<a name="431" href="#431">431</a>                 col.add(defValue);
<a name="432" href="#432">432</a>                 col.add(decimalDigits);
<a name="433" href="#433">433</a>                 columns.add(col);
<a name="434" href="#434">434</a>             }
<a name="435" href="#435">435</a>         }
<a name="436" href="#436">436</a>         <strong>finally</strong>
<a name="437" href="#437">437</a>         {
<a name="438" href="#438">438</a>             <strong>if</strong> (columnSet != <strong>null</strong>)
<a name="439" href="#439">439</a>             {
<a name="440" href="#440">440</a>                 columnSet.close();
<a name="441" href="#441">441</a>             }
<a name="442" href="#442">442</a>         }
<a name="443" href="#443">443</a>         <strong>return</strong> columns;
<a name="444" href="#444">444</a>     }
<a name="445" href="#445">445</a> 
<a name="446" href="#446">446</a>     <em>/**<em>*</em></em>
<a name="447" href="#447">447</a> <em>     * Retrieves a list of the columns composing the primary key for a given</em>
<a name="448" href="#448">448</a> <em>     * table.</em>
<a name="449" href="#449">449</a> <em>     *</em>
<a name="450" href="#450">450</a> <em>     * @param dbMeta JDBC metadata.</em>
<a name="451" href="#451">451</a> <em>     * @param tableName Table from which to retrieve PK information.</em>
<a name="452" href="#452">452</a> <em>     * @return A list of the primary key parts for &lt;code>tableName&lt;/code>.</em>
<a name="453" href="#453">453</a> <em>     * @throws SQLException</em>
<a name="454" href="#454">454</a> <em>     */</em>
<a name="455" href="#455">455</a>     <strong>public</strong> List getPrimaryKeys(DatabaseMetaData dbMeta, String tableName)
<a name="456" href="#456">456</a>             throws SQLException
<a name="457" href="#457">457</a>     {
<a name="458" href="#458">458</a>         List pk = <strong>new</strong> ArrayList();
<a name="459" href="#459">459</a>         ResultSet parts = <strong>null</strong>;
<a name="460" href="#460">460</a>         <strong>try</strong>
<a name="461" href="#461">461</a>         {
<a name="462" href="#462">462</a>             parts = dbMeta.getPrimaryKeys(<strong>null</strong>, dbSchema, tableName);
<a name="463" href="#463">463</a>             <strong>while</strong> (parts.next())
<a name="464" href="#464">464</a>             {
<a name="465" href="#465">465</a>                 pk.add(parts.getString(4));
<a name="466" href="#466">466</a>             }
<a name="467" href="#467">467</a>         }
<a name="468" href="#468">468</a>         <strong>finally</strong>
<a name="469" href="#469">469</a>         {
<a name="470" href="#470">470</a>             <strong>if</strong> (parts != <strong>null</strong>)
<a name="471" href="#471">471</a>             {
<a name="472" href="#472">472</a>                 parts.close();
<a name="473" href="#473">473</a>             }
<a name="474" href="#474">474</a>         }
<a name="475" href="#475">475</a>         <strong>return</strong> pk;
<a name="476" href="#476">476</a>     }
<a name="477" href="#477">477</a> 
<a name="478" href="#478">478</a>     <em>/**<em>*</em></em>
<a name="479" href="#479">479</a> <em>     * Retrieves a list of foreign key columns for a given table.</em>
<a name="480" href="#480">480</a> <em>     *</em>
<a name="481" href="#481">481</a> <em>     * @param dbMeta JDBC metadata.</em>
<a name="482" href="#482">482</a> <em>     * @param tableName Table from which to retrieve FK information.</em>
<a name="483" href="#483">483</a> <em>     * @return A list of foreign keys in &lt;code>tableName&lt;/code>.</em>
<a name="484" href="#484">484</a> <em>     * @throws SQLException</em>
<a name="485" href="#485">485</a> <em>     */</em>
<a name="486" href="#486">486</a>     <strong>public</strong> Collection getForeignKeys(DatabaseMetaData dbMeta, String tableName)
<a name="487" href="#487">487</a>         throws SQLException
<a name="488" href="#488">488</a>     {
<a name="489" href="#489">489</a>         Hashtable fks = <strong>new</strong> Hashtable();
<a name="490" href="#490">490</a>         ResultSet foreignKeys = <strong>null</strong>;
<a name="491" href="#491">491</a>         <strong>try</strong>
<a name="492" href="#492">492</a>         {
<a name="493" href="#493">493</a>             foreignKeys = dbMeta.getImportedKeys(<strong>null</strong>, dbSchema, tableName);
<a name="494" href="#494">494</a>             <strong>while</strong> (foreignKeys.next())
<a name="495" href="#495">495</a>             {
<a name="496" href="#496">496</a>                 String refTableName = foreignKeys.getString(3);
<a name="497" href="#497">497</a>                 String fkName = foreignKeys.getString(12);
<a name="498" href="#498">498</a>                 <em class="comment">// if FK has no name - make it up (use tablename instead)</em>
<a name="499" href="#499">499</a>                 <strong>if</strong> (fkName == <strong>null</strong>)
<a name="500" href="#500">500</a>                 {
<a name="501" href="#501">501</a>                     fkName = refTableName;
<a name="502" href="#502">502</a>                 }
<a name="503" href="#503">503</a>                 Object[] fk = (Object[]) fks.get(fkName);
<a name="504" href="#504">504</a>                 List refs;
<a name="505" href="#505">505</a>                 <strong>if</strong> (fk == <strong>null</strong>)
<a name="506" href="#506">506</a>                 {
<a name="507" href="#507">507</a>                     fk = <strong>new</strong> Object[2];
<a name="508" href="#508">508</a>                     fk[0] = refTableName; <em class="comment">//referenced table name</em>
<a name="509" href="#509">509</a>                     refs = <strong>new</strong> ArrayList();
<a name="510" href="#510">510</a>                     fk[1] = refs;
<a name="511" href="#511">511</a>                     fks.put(fkName, fk);
<a name="512" href="#512">512</a>                 }
<a name="513" href="#513">513</a>                 <strong>else</strong>
<a name="514" href="#514">514</a>                 {
<a name="515" href="#515">515</a>                     refs = (ArrayList) fk[1];
<a name="516" href="#516">516</a>                 }
<a name="517" href="#517">517</a>                 String[] ref = <strong>new</strong> String[2];
<a name="518" href="#518">518</a>                 ref[0] = foreignKeys.getString(8); <em class="comment">//local column</em>
<a name="519" href="#519">519</a>                 ref[1] = foreignKeys.getString(4); <em class="comment">//foreign column</em>
<a name="520" href="#520">520</a>                 refs.add(ref);
<a name="521" href="#521">521</a>             }
<a name="522" href="#522">522</a>         }
<a name="523" href="#523">523</a>         <strong>catch</strong> (SQLException e)
<a name="524" href="#524">524</a>         {
<a name="525" href="#525">525</a>             <em class="comment">// this seems to be happening in some db drivers (sybase)</em>
<a name="526" href="#526">526</a>             <em class="comment">// when retrieving foreign keys from views.</em>
<a name="527" href="#527">527</a>             log(<span class="string">"WARN: Could not read foreign keys for Table "</span>
<a name="528" href="#528">528</a>                         + tableName
<a name="529" href="#529">529</a>                         + <span class="string">" : "</span>
<a name="530" href="#530">530</a>                         + e.getMessage(),
<a name="531" href="#531">531</a>                     Project.MSG_WARN);
<a name="532" href="#532">532</a>         }
<a name="533" href="#533">533</a>         <strong>finally</strong>
<a name="534" href="#534">534</a>         {
<a name="535" href="#535">535</a>             <strong>if</strong> (foreignKeys != <strong>null</strong>)
<a name="536" href="#536">536</a>             {
<a name="537" href="#537">537</a>                 foreignKeys.close();
<a name="538" href="#538">538</a>             }
<a name="539" href="#539">539</a>         }
<a name="540" href="#540">540</a>         <strong>return</strong> fks.values();
<a name="541" href="#541">541</a>     }
<a name="542" href="#542">542</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

